Transforms forReportBean


ReportPageByInfoTransform

Formal Parameter Type Default Required Description
contextMenus STRING   false

This formal parameter is used by the Transform to identify the context-menus definition. The value of this parameter can specify either:

  1. The name of a <menu> defined in the pageConfig
  2. The path of an xml file with the context-menu definition

In both cases the xml defines the context-menus using <shortcut-list-set> tags. A <shortcut-list-set> represents a collection of <shortcut-list> tags. Each <shortcut-list> represents a single context-menu. Each <shortcut> represents a single option. Users can add/remove/modify <shortcut> to control the options displayed to the end user.
cssErrorMessage STRING error-message false

Deprecated. This formal parameter is not referenced anywhere in the code


This is the css name for the error message.
Allowed Values: String value representing a css class name. It should be defined in a css file included in the page.
cssErrorTitle STRING error-title false

Deprecated. This formal parameter is not referenced anywhere in the code


This is the css name for the error title.
Allowed Values: String value representing a css class name. It should be defined in a css file included in the page.
cssPrefix STRING   false Prefix to append to all css class names.
cssUseFileContent BOOLEAN false false This is the flag used in the transform to specify whether to show a link to the CSS file or the whole CSS file content.
Allowed Values: TRUE/FALSE.
debugErrorFlags INTEGER 65535 false Indicates which extra debug information to include in case of an error.
The flags are taken from the EnumWebAppDebugFlags enumeration.
debugFlags INTEGER 0 false Indicates which debug information to include.
The flags are taken from the EnumWebAppDebugFlags enumeration.
displayInSingleLine BOOLEAN true false It is used in the transform to specify whether display all the pageby elements in one line or seperate lines.
Allowed Values: TRUE/FALSE.
displayWhenNone BOOLEAN true false It is used in the transform to specify whether display when there is no pageby elements.
Allowed Values: TRUE/FALSE.
extraInput STRING   false Indicates any extra inputs to be included in the forms generated by the transform.
extraUrl STRING   false Indicates any extra parameters to be included in the links generated by the transform.
globalCssErrorMessage STRING error-message false

Deprecated. The css class to use for the title cannot be controlled by a Formal Parameter anymore.


CSS to be used in all error messages.
globalCssErrorTitle STRING error-title false

Deprecated. The css class to use for the title cannot be controlled by a Formal Parameter anymore.


CSS to be used in all Error titles.
height STRING   false Indicates the default height of the component. If this is not a resizable component, this is the height used. If if it resizable, though, the user might change its width using javascript and the value is saved in a preference; thereafter the Transform will use this new value for this component.
imgError STRING jobError.gif false This is the Image to display when there bean is in Error status.
Allowed Values: The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
imgWait STRING ani_wait.gif false

Deprecated. This value is not used anymore by the Transform as the wait image is included using css.


Name of the image for the Processing icon on the Wait page.
Allowed Values:
The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
infoTitle STRING   false It is used in the transform to specify the title for this section.
Allowed Values: any String
initialIndent INTEGER 0 false

Deprecated. Indentation is not appended by Transforms anymore.


Indicates the initial indentation of the HTML generated.
isPlainText BOOLEAN false false It is used in the transform to specify whether display in plain text or html.
Allowed Values: TRUE/FALSE.
scriptClass STRING   false Holds the name of the javaScript class (if any) to be associated with the component. When the scriptClass is specified, a bone is registered on the page for this component. A bone is the corresponding concept of a bean in Microstrategy's javascript environment.
By default, thie methods returns an empty string. Transform which does have an associated bone needs to override this method.
useBuiltInFormat BOOLEAN true false This is the flag used in the transform to specify whether to use the formatting info from the report definition.
Out of box, we map the first preference in Grid preferences section to this formal parameter.
If it's TRUE, WebCSSHelper.getCSS() will give the css class definitions, which is from report formatting defintion.
If it's FALSE, a specified css file will give the css class definitions, which is what formal paramter cssFile means.
Allowed Values: TRUE/FALSE.
useDHTML BOOLEAN true false Indicates whether to use DHTML on the output.
If not set, the bean's OutputFormat() method will be used.